Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add required tests for go/mysql/hex #14976

Merged
merged 5 commits into from
Jan 18, 2024
Merged

Add required tests for go/mysql/hex #14976

merged 5 commits into from
Jan 18, 2024
+102 −0

Conversation

beingnoble03
Copy link
Member

Description

This PR adds required tests for go/mysql/hex

Related Issue(s)

Fixes part of #14931

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 17, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 17, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 17, 2024
@codecov Codecov
Copy link

codecov bot commented Jan 17, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c1f9c80) 47.26% compared to head (76ef13a) 47.31%.
Report is 12 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #14976      +/-   ##
==========================================
+ Coverage   47.26%   47.31%   +0.05%     
==========================================
  Files        1138     1140       +2     
  Lines      238842   238962     +120     
==========================================
+ Hits       112880   113069     +189     
+ Misses     117368   117298      -70     
- Partials     8594     8595       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dbussink
dbussink reviewed Jan 17, 2024
View reviewed changes
go/mysql/hex/hex_test.go Outdated

for _, tCase := range testCases {
got := EncodeBytes(tCase.input)
assert.Equalf(t, tCase.want, got, "got %v, want %v", got, tCase.want)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can just do assert.Equal(t, tCase.want, got) here and in the other cases. The additional stuff here doesn't seem to add much.

This also applies to the other cases here in this file.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand. Makes sense; I'll proceed accordingly.

@mattlord mattlord mentioned this pull request Jan 17, 2024
Open
@dbussink dbussink added Type: Testing Component: General Changes throughout the code base and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 17, 2024
dbussink
dbussink reviewed Jan 18, 2024
View reviewed changes
go/mysql/hex/hex_test.go Outdated
// DecodeBytes should return an error for "é" as
// hex.decode returns an error for non-ASCII characters
err = DecodeBytes([]byte("testDst"), []byte("é"))
assert.Errorf(t, err, "expected error to appear for invalid byte, got %v", err)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can also drop the Errorf here. It's not very useful, as err will always be nil anyway.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm...right. Done. Replaced the error message with DecodeBytes() should have errored as src contains non-ASCII character.

dbussink
dbussink reviewed Jan 18, 2024
View reviewed changes
go/mysql/hex/hex_test.go Outdated
@@ -98,5 +98,5 @@ func TestDecodeBytes(t *testing.T) {
// DecodeBytes should return an error for "é" as
// hex.decode returns an error for non-ASCII characters
err = DecodeBytes([]byte("testDst"), []byte("é"))
assert.Error(t, err)
assert.Error(t, err, "DecodeBytes() should have errored as src contains non-ASCII character")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason for having a custom message at all?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have added custom messages earlier in other tests too. So, I added here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think it add a lot of value here? I think we can go for the minimal setup and only add something custom if there’s explicit value in doing so.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

frouioui
frouioui approved these changes Jan 18, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@frouioui frouioui merged commit 515c8c4 into vitessio:main Jan 18, 2024
102 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui approved these changes

@dbussink dbussink dbussink approved these changes

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Testing
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@beingnoble03 @dbussink @frouioui